home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbsdoors / hangmn15.zip / SYSOP.DOC < prev    next >
Text File  |  1993-04-07  |  12KB  |  281 lines
  1. This document is effective 12/15/92
  2. SYSOP COMMANDS - BOI 2.00
  3.  
  4. For use with POKERDOR and HANGMAN...
  5.  
  6.     BBS Onliner Interface
  7.     Copyright (C) 1990,1992 Andrew J. Mead
  8.     All Rights Reserved.
  9.  
  10. Introduction
  11.  
  12.     This documentation is a User's Reference Manual for the BBS Onliner
  13.     Interface.  It details available command line parameters and SysOp
  14.     control function keys.  Important Note: All features discussed may
  15.     not be available any given door, and any given door may have
  16.     additional features that are not covered here.  Please refer to any
  17.     door specific documentation as well.
  18.  
  19.       Sections
  20.  
  21.       Command Line Parameters Reference
  22.         BBS Drop File Commands
  23.         Communications Directives
  24.           Local Play
  25.           FOSSIL Communications
  26.           Internal Asynchronious Communications
  27.           Additional Communication Directives
  28.         Configuration Directives
  29.  
  30.       SysOp Function Keys
  31.  
  32.  
  33. BBS Onliner Interface - Command Line Parameters Reference
  34.  
  35.     Notice - This is a listing of all parameters available in the BBS
  36.         Onliner Interface. Not all of these commands may be available
  37.         or have any meaning for the door you are installing.  Also
  38.         note that on the commands that take additional parameters, that
  39.         the initial colon (:) is usually optional, and is only used for
  40.         clarity.
  41.  
  42.     BBS Drop File Commands
  43.         The BOI automatically reads many common drop files, as well as
  44.         being able to accept command line parameters directly from the
  45.         BBS.  Please check the list below for a dropfile created by
  46.         your BBS software.  See INSTALL.DOC for specific information
  47.         and examples.
  48.  
  49.  !  If your BBS generates a dorinfox.def or some such file, the file should
  50.  !  be copied to the same directory as HANGMAN.EXE prior to running the door.
  51.  
  52.         This list is far from comprehensive, and I encourage any and all
  53.         of you to send me samples of your installation, or information
  54.         about what drop file(s) your BBS can create.
  55.  
  56.         command   dropfile      BBS software - Notes
  57.          /1       PCBOARD.SYS   PCBoard 12.x (see /P)
  58.          /2       JUMBER.DAT    2 A.M.
  59.          /3                     OPUS 1.13 (not available)
  60.          /4       CHAIN.TXT     WWIV, VBBS, TAG, Telegard
  61.          /5       CURRUSER.BBS  RyBBS
  62.          /6       SFDOORS.DAT   Spitfire BBS
  63.          /7       AUNTIE.SYS    Auntie BBS (same format as /1)
  64.          /8                     Sapphire BBS (not available)
  65.          /9       command line  Searchlight, Simplex
  66.          /D       DOOR.SYS      DoorWay to Unlimited Doors, GT
  67.                                 NOTE:This is the "Short" Door.Sys see /S
  68.          /F       USERINFO.TXT  Forum
  69.          /G       CALLINFO.BBS  Genesis (beta)
  70.          /H       INFO.TXT      Phoenix
  71.          /M       NUMBER.TXT    ModuleX
  72.          /O       LASTUSER.DAT  Opus 1.14
  73.          /Oxx     LASTUSxx.DAT  Opus 1.14 where "xx" is the task number
  74.                                 in hexadecimal
  75.          /P       PCBOARD.SYS   PCBoard 14.x (see /1)
  76.          /S       DOOR.SYS      GAP, Force, Remote Acess 2.0g1
  77.                                 NOTE: This is the "Long" Door.Sys see /D
  78.          /W       CALLINFO.BBS  WildCat!, Telegard
  79.  
  80.          /R       DOORINFO.DEF  DorInfo is the most widely used file.
  81.          /R#      DORINFO#.DEF  EIS-PC, FoReM, OLEcom, QuickBBS, RBBS,
  82.                                 Remote Access 1.11, TAG, TPBoard, UBBS, and
  83.                                 VBBS. the "#" represents the node number
  84.  
  85.         If this command is missing, the door will default to local mode.
  86.  
  87.         Drop File Path
  88.             If (as recommended) you do not run your online doors from
  89.             your BBS directory, you need to tell the BOI where to find
  90.             the drop file.  You can either copy the file, or add the
  91.             drop file's path to the command line.  Here's an example
  92.             with WildCat! assuming the BBS is in c:\wcat.
  93.  
  94.           doorgame /w:c:\wcat\
  95.  
  96.             Note: the "\" on the end of the path is required, and that
  97.             the first ":" (w:c) is optional (for clarity).
  98.  
  99.         The BOI reads user name, user time remaining, user comm port,
  100.         and (where available) user handle, user screen size, and if the
  101.         user is on the local console.
  102.  
  103.  
  104.     Communications Directives
  105.         Left to its own, the interface will normally detect local play
  106.         from the drop file.  The override switches (/C, /I, /L) should
  107.         only be used with great care.
  108.  
  109.         LOCAL play
  110.             The BOI will normally sense local play, but you can force it
  111.  
  112.             command   effect
  113.              /L       Force LOCAL mode.  Can NOT be overridden.  If
  114.                       either /c or /i is present the door will exit.
  115.  
  116.         FOSSIL Communications
  117.             FOSSIL communications are automatically sensed and used if
  118.             present.  You can, however, influence, their use.  You
  119.             should also note that there are NO slashes (/) before these
  120.             FOSSIL commands.
  121.  
  122.             command   effect
  123.              F-       Do NOT use FOSSIL (/i command gives same result)
  124.  
  125.              F+       Force FOSSIL use. (ignored if /i command present)
  126.                       If FOSSIL not found, door will exit.
  127.  
  128.              F@       Deinitialize FOSSIL when through.  By default, the
  129.                       BOI keeps the FOSSIL "hot".  This can be combined
  130.                       with the above option (F+@).
  131.  
  132.              /C:n     comport to use (see /C:n below).
  133.  
  134.         Internal Asynchronious Communincations
  135.             The BOI contains its own fully functional communciations
  136.             library that is very configurable.  If FOSSIL is either
  137.             disabled or not found, these routines will be used.
  138.  
  139.             command   effect
  140.              /B       Locked BAUD (DTE-DCE) rate.  If you are running
  141.                       your modem with a "locked" baud rate, you will
  142.                       NEED to add this command to your command line.
  143.                       The internal routines use RTS handshaking by
  144.                       default.  This switch tells them to use CTS/RTS
  145.                       handshaking which prevents modem overrun.
  146.  
  147.              /C:n     Serial port to use.  You can force the program to
  148.                       use a given serial port.  Valid values are from
  149.                       1 to 8.  (NOTE: 5 to 8 are only defined if the
  150.                       FOSSIL is also used).  This command is necessary
  151.                       if the drop file is wrong, or you are using
  152.                       command line directives only.  If /l or /i is
  153.                       present the door will exit.
  154.  
  155.             /I:x:nnnn Non-standard IRQ specification.  If you are not
  156.                       using FOSSIL, and you do have a non-standard
  157.                       serial port configuartion, you can use this
  158.                       option to specify your IRQ/port address info.
  159.                       The default settings, would be equivalent to
  160.                           Com1 : /i:4:03f8
  161.                           Com2 : /i:3:02f8
  162.                           Com3 : /i:4:03e8
  163.                           Com4 : /i:3:02e8
  164.                       The 'x' is the IRQ number.  It is a hexidecimal
  165.                       value from 0 to f.  'nnnn' is the port address for
  166.                       communications.  It is a 4 digit hexidecimal value
  167.                       If this command is present, the FOSSIL routines
  168.                       will not be used.  If /c or /l is present the door
  169.                       will exit.
  170.  
  171.         Additional Communications Directives
  172.             command   effect
  173.              /K       Do NOT check for Carrier detect.  This should only
  174.                       be used in dire cases.  If this switch is used,
  175.                       the door may not time out if the remote user hangs
  176.                       up the phone.
  177.  
  178.                       If your modem does not properly maintain a Carrier
  179.                       Detect signal, the game will automatically abort.
  180.                       This option supresses this activity. If you are
  181.                       forced to use this option, you probably are having
  182.                       hardware problems with the modem, RS-232 connector
  183.                       (bad pin or broken wire), or modem cable.
  184.  
  185.  
  186.     Configuration Directives
  187.         command  effect
  188.          /A      Play Again? (default x=10)
  189.          /A:x    If this mode is present, it is available with the door
  190.                  you are using, and the user has more than x minutes
  191.                  remaining, they will be asked if they wish to play
  192.                  again.
  193.  
  194.          /N:...  User Name (ie: /n:Doc_Technical)
  195.                  This option allows you to pass the door the user's name
  196.                  through the command line.  This is handy for BBSes like
  197.                  Searchlight, or if you are playing locally from DOS.
  198.                  Underscores are converted to spaces.
  199.  
  200.          /Q      Quiet Local Mode
  201.                  This will prevent all ^G bells from ringing the local
  202.                  console.  (Unless the door author specifically
  203.                  overrides it).  This option will help SysOps get full
  204.                  nights worth of sleep.
  205.  
  206.          /Z:x    User Time Limit
  207.                  x is an amount of time between 10 and 50.  The user's
  208.                  time allowed will be the lesser of this value, and the
  209.                  amount found in the BBS drop file.
  210.  
  211.          /X:n    Limit Hall of Fame listings
  212.                  You can limit the time any one name appears in the
  213.                  monthly top 20 with this switch.  The default is no
  214.                  limitation.  The recommended limit is 1 or 2.  This
  215.                  keeps a small number of players from monopolizing the
  216.                  game.  If an occassional (non-fanatical) is more likely
  217.                  to see his name listed, he is more likely to play the
  218.                  game.  n is any number from 1 to 19.
  219.  
  220.          /Y      Alternate path/filespec for text Hall of Fame
  221.                  /y:<pathspec>\   (ie: /y:c:\wcat\bulls\)
  222.                      In the sample above, the text Hall of Fame (if
  223.                      applicable) will be placed into c:\wcat\bulls
  224.                      using the default name (found in the games docs).
  225.                  /y:<filespec>    (ie: /y:c:\wcat\bulls\bull4.bbs)
  226.                      In the sample above, the text Hall of Fame will be
  227.                      placed in c:\wcat\bulls, and it will be named
  228.                      bull4.bbs.
  229.  
  230.          A+      Enable AVATAR/1.  NOTE: The AVATAR codes are
  231.                  relatively untested.  If you use this switch, please
  232.                  let me know whether it works or doesn't.
  233.  
  234.  
  235. BBS Onliner Interface - SysOp Function Keys
  236.     The SysOp is afforded the following SysOp functions.
  237.  
  238.     keypress  action
  239.  
  240.      F7       Decrement (reduce) user's time remaining by 1 minute.
  241.      F8       Increment (increase) user's time remaining by 1 minute.
  242.  
  243.      F9       Drop Carrier.  (Fake line noise).  This will disconnect
  244.               the current communications and send the user a string of
  245.               random characters to simulate line noise.
  246.  
  247.      F10      Force return to BBS.  This sends the user a notice
  248.               informing them that the SysOp has terminated the session.
  249.               It then returns control to the BBS.  (Ctrl-Break) will
  250.               also exit the game, but not as pleasently.
  251.  
  252.  
  253. BBS Onliner Interface
  254. Copyright (C) 1990, 1992 Andrew J. Mead
  255. All Rights Reserved.
  256.  
  257. Contact:
  258.     Andrew J. Mead
  259.     PO BOX 1155
  260.     Chapel Hill, NC 27514-1155
  261.     USA
  262.  
  263.     1@9952 WWIVnet
  264.     1@9395 VirtualNet
  265.     1:3641/417 FidoNet
  266.     75:7919/417 DoorNet
  267.  
  268. +919 489 9446 - PCP:NCRTP - V32BIS - 24HRS
  269.  
  270. This interface is currently written in Turbo Pascal 5.5, 6.0 and
  271. can be licensed by other programmers.  Contact me for details.
  272.  
  273. The latest version of HANGMAN and other Lachen Creations
  274. are always available from
  275. \ The Lighthouse BBS /
  276.        9600 - 8N1 - (PCP:DCWAS) - 1-301-645-8624
  277.        1:109/804 FidoNet
  278.  
  279. 04/07/93 LHN
  280. END SYSOP.DOC
  281.